

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>pyamp.ui.qt.keyEvents &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../../../../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../../../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../../../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../../../../index.html" />
    <link rel="up" title="pyamp.ui.qt" href="../qt.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../../../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../qt.html" accesskey="U">pyamp.ui.qt</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for pyamp.ui.qt.keyEvents</h1><div class="highlight"><pre>
<span class="c"># Copyright 2012 Brett Ponsler</span>
<span class="c"># This file is part of pyamp.</span>
<span class="c">#</span>
<span class="c"># pyamp is free software: you can redistribute it and/or modify</span>
<span class="c"># it under the terms of the GNU General Public License as published by</span>
<span class="c"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c"># (at your option) any later version.</span>
<span class="c">#</span>
<span class="c"># pyamp is distributed in the hope that it will be useful,</span>
<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<span class="c"># GNU General Public License for more details.</span>
<span class="c">#</span>
<span class="c"># You should have received a copy of the GNU General Public License</span>
<span class="c"># along with pyamp.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<span class="sd">&#39;&#39;&#39;The keyEvents module contains the KeyEvents class which provides the</span>
<span class="sd">ability to parse a QKeyEvent into a string representation of the keys</span>
<span class="sd">that were pressed.</span>

<span class="sd">&#39;&#39;&#39;</span>
<span class="kn">from</span> <span class="nn">PyQt4.QtCore</span> <span class="kn">import</span> <span class="n">Qt</span>


<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;KeyEvents&#39;</span><span class="p">]</span>


<div class="viewcode-block" id="KeyEvents"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_keyEvents.html#pyamp.ui.qt.keyEvents.KeyEvents">[docs]</a><span class="k">class</span> <span class="nc">KeyEvents</span><span class="p">:</span>
    <span class="sd">&#39;&#39;&#39;This class provided functions for dealing with</span>
<span class="sd">    :class:`PyQt4.QtGui.QKeyEvent` objects.</span>

<span class="sd">    The main function of this class is to provide a method to convert a</span>
<span class="sd">    :class:`PyQt4.QtGui.QKeyEvent` object into a string representation of the</span>
<span class="sd">    keys that were pressed in the given event.</span>

<span class="sd">    &#39;&#39;&#39;</span>
    <span class="c"># @todo: ADD ALL THE Qt.KEYS TO THIS LIST, including 0-255 keys</span>
    <span class="c"># @todo: after that, get rid of the two separate key handling parts in</span>
    <span class="c">#        parse</span>
    <span class="c"># found: http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qt.html#KeyboardModifier-enum</span>
    <span class="n">KeyMap</span> <span class="o">=</span> <span class="p">{</span>
        <span class="n">Qt</span><span class="o">.</span><span class="n">Key_Escape</span><span class="p">:</span> <span class="s">&#39;ESC&#39;</span><span class="p">,</span>
        <span class="n">Qt</span><span class="o">.</span><span class="n">Key_Tab</span><span class="p">:</span> <span class="s">&#39;TAB&#39;</span><span class="p">,</span>
        <span class="n">Qt</span><span class="o">.</span><span class="n">Key_Backspace</span><span class="p">:</span> <span class="s">&#39;BKSPC&#39;</span><span class="p">,</span>
        <span class="n">Qt</span><span class="o">.</span><span class="n">Key_Return</span><span class="p">:</span> <span class="s">&#39;RET&#39;</span><span class="p">,</span>
        <span class="n">Qt</span><span class="o">.</span><span class="n">Key_Enter</span><span class="p">:</span> <span class="s">&#39;ENT&#39;</span><span class="p">,</span>
        <span class="p">}</span>

    <span class="nd">@classmethod</span>
<div class="viewcode-block" id="KeyEvents.parse"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_keyEvents.html#pyamp.ui.qt.keyEvents.KeyEvents.parse">[docs]</a>    <span class="k">def</span> <span class="nf">parse</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Parse the given QKeyEvent into the string representation of</span>
<span class="sd">        the keys pressed.</span>

<span class="sd">        * event -- The QKeyEvent</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="n">keyList</span> <span class="o">=</span> <span class="n">KeyEvents</span><span class="o">.</span><span class="n">__getModifiers</span><span class="p">(</span><span class="n">event</span><span class="p">)</span>

        <span class="c"># Convert the key into a character, assuming it&#39;s within the</span>
        <span class="c"># proper range</span>
        <span class="k">if</span> <span class="n">event</span><span class="o">.</span><span class="n">key</span><span class="p">()</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">256</span><span class="p">):</span>
            <span class="n">keyList</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">chr</span><span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">key</span><span class="p">()))</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="n">specialKey</span> <span class="o">=</span> <span class="n">KeyEvents</span><span class="o">.</span><span class="n">__getSpecialKey</span><span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">key</span><span class="p">())</span>
            <span class="k">if</span> <span class="n">specialKey</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
                <span class="n">keyList</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">specialKey</span><span class="p">)</span>

        <span class="k">return</span> <span class="s">&#39;-&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">keyList</span><span class="p">)</span>
</div>
    <span class="nd">@classmethod</span>
    <span class="k">def</span> <span class="nf">__getModifiers</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">event</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Get the list of pressed modifiers from the current key event.</span>

<span class="sd">        * event -- The QKeyEvent</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="n">keyList</span> <span class="o">=</span> <span class="p">[]</span>

        <span class="n">modMap</span> <span class="o">=</span> <span class="p">{</span><span class="n">Qt</span><span class="o">.</span><span class="n">ControlModifier</span><span class="p">:</span> <span class="s">&#39;C&#39;</span><span class="p">,</span>
                  <span class="n">Qt</span><span class="o">.</span><span class="n">AltModifier</span><span class="p">:</span> <span class="s">&#39;A&#39;</span><span class="p">,</span>
                  <span class="n">Qt</span><span class="o">.</span><span class="n">MetaModifier</span><span class="p">:</span> <span class="s">&#39;M&#39;</span><span class="p">}</span>

        <span class="c"># Check each of the modifiers in the dictionary against</span>
        <span class="c"># the currently pressed modifiers</span>
        <span class="n">modifiers</span> <span class="o">=</span> <span class="n">event</span><span class="o">.</span><span class="n">modifiers</span><span class="p">()</span>
        <span class="k">for</span> <span class="n">modifier</span> <span class="ow">in</span> <span class="n">modMap</span><span class="p">:</span>
            <span class="c"># If the modifier is pressed, keep track of it</span>
            <span class="k">if</span> <span class="n">modifier</span> <span class="o">&amp;</span> <span class="n">modifiers</span><span class="p">:</span>
                <span class="n">keyList</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">modMap</span><span class="p">[</span><span class="n">modifier</span><span class="p">])</span>

        <span class="k">return</span> <span class="n">keyList</span>

    <span class="nd">@classmethod</span>
    <span class="k">def</span> <span class="nf">__getSpecialKey</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Get the string representation for a special key.</span>

<span class="sd">        * key -- The key pressed</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="c"># Traverse all of the keys to determine which key this is</span>
        <span class="k">for</span> <span class="n">keyValue</span> <span class="ow">in</span> <span class="n">KeyEvents</span><span class="o">.</span><span class="n">KeyMap</span><span class="p">:</span>
            <span class="k">if</span> <span class="n">keyValue</span> <span class="o">==</span> <span class="n">key</span><span class="p">:</span>
                <span class="k">return</span> <span class="n">KeyEvents</span><span class="o">.</span><span class="n">KeyMap</span><span class="p">[</span><span class="n">keyValue</span><span class="p">]</span>

        <span class="k">return</span> <span class="bp">None</span></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../../../../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../../../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../qt.html" >pyamp.ui.qt</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>